
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module fgcp.client</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="fgcp.html"><font color="#ffffff">fgcp</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="http://code.google.com/p/fgcp-client-api/source/browse/fgcp/client.py">client.py</a></font></td></tr></table>
    <p><tt>Client&nbsp;Methods&nbsp;for&nbsp;the&nbsp;Fujitsu&nbsp;Global&nbsp;Cloud&nbsp;Platform&nbsp;(FGCP)<br>
&nbsp;<br>
Example:&nbsp;[see&nbsp;tests/test_client.py&nbsp;for&nbsp;more&nbsp;examples]<br>
&nbsp;<br>
#&nbsp;Connect&nbsp;with&nbsp;your&nbsp;client&nbsp;certificate&nbsp;to&nbsp;region&nbsp;'uk'<br>
from&nbsp;fgcp.client&nbsp;import&nbsp;<a href="#FGCPClient">FGCPClient</a><br>
client&nbsp;=&nbsp;<a href="#FGCPClient">FGCPClient</a>('client.pem',&nbsp;'uk')<br>
&nbsp;<br>
#&nbsp;Call&nbsp;custom&nbsp;client&nbsp;methods<br>
client.ShowSystemStatus()<br>
&nbsp;<br>
The&nbsp;client&nbsp;methods&nbsp;below&nbsp;are&nbsp;organized&nbsp;by&nbsp;client&nbsp;role,&nbsp;i.e.&nbsp;Monitor,&nbsp;Operator,&nbsp;Designer&nbsp;and&nbsp;Client.<br>
&nbsp;<br>
Note:&nbsp;with&nbsp;version&nbsp;1.0.x&nbsp;and&nbsp;later&nbsp;of&nbsp;the&nbsp;library,&nbsp;most&nbsp;of&nbsp;these&nbsp;client&nbsp;methods&nbsp;can&nbsp;now&nbsp;directly&nbsp;be<br>
replaced&nbsp;by&nbsp;corresponding&nbsp;resource&nbsp;actions.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="time.html">time</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="fgcp.html#FGCPError">fgcp.FGCPError</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.client.html#FGCPClientError">FGCPClientError</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>(<a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.client.html#FGCPOperator">FGCPOperator</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.client.html#FGCPDesigner">FGCPDesigner</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.client.html#FGCPClient">FGCPClient</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPClient">class <strong>FGCPClient</strong></a>(<a href="fgcp.client.html#FGCPDesigner">FGCPDesigner</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>FGCP&nbsp;Client&nbsp;Methods<br>
&nbsp;<br>
Example:<br>
#&nbsp;Connect&nbsp;with&nbsp;your&nbsp;client&nbsp;certificate&nbsp;in&nbsp;region&nbsp;'uk'<br>
from&nbsp;fgcp.client&nbsp;import&nbsp;<a href="#FGCPClient">FGCPClient</a><br>
client&nbsp;=&nbsp;<a href="#FGCPClient">FGCPClient</a>('client.pem',&nbsp;'uk')<br>
&nbsp;<br>
#&nbsp;Backup&nbsp;all&nbsp;VServers&nbsp;in&nbsp;some&nbsp;VSystem<br>
vsys&nbsp;=&nbsp;client.<a href="#FGCPClient-GetSystemInventory">GetSystemInventory</a>('Python&nbsp;API&nbsp;Demo&nbsp;System')<br>
for&nbsp;vserver&nbsp;in&nbsp;vsys.vservers:<br>
&nbsp;&nbsp;&nbsp;&nbsp;client.<a href="#FGCPClient-BackupVServerAndRestart">BackupVServerAndRestart</a>(vsys.vsysId,&nbsp;vserver.vserverId)<br>
client.<a href="#FGCPClient-CleanupBackups">CleanupBackups</a>(vsys.vsysId)<br>
&nbsp;<br>
#&nbsp;Note:&nbsp;you&nbsp;can&nbsp;also&nbsp;use&nbsp;all&nbsp;API&nbsp;commands&nbsp;from&nbsp;<a href="fgcp.command.html#FGCPCommand">FGCPCommand</a>()<br>
vsystems&nbsp;=&nbsp;client.<a href="#FGCPClient-ListVSYS">ListVSYS</a>()<br>
for&nbsp;vsys&nbsp;in&nbsp;vsystems:<br>
&nbsp;&nbsp;&nbsp;&nbsp;vsysconfig&nbsp;=&nbsp;client.<a href="#FGCPClient-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)<br>
&nbsp;&nbsp;&nbsp;&nbsp;...<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.client.html#FGCPClient">FGCPClient</a></dd>
<dd><a href="fgcp.client.html#FGCPDesigner">FGCPDesigner</a></dd>
<dd><a href="fgcp.client.html#FGCPOperator">FGCPOperator</a></dd>
<dd><a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a></dd>
<dd><a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a></dd>
<dd><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a></dd>
<dd><a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a></dd>
</dl>
<hr>
Methods inherited from <a href="fgcp.client.html#FGCPDesigner">FGCPDesigner</a>:<br>
<dl><dt><a name="FGCPClient-ConfigureSystem"><strong>ConfigureSystem</strong></a>(self, vsysName, systemDesign, verbose<font color="#909090">=None</font>)</dt><dd><tt>Configure&nbsp;VSystem&nbsp;based&nbsp;on&nbsp;some&nbsp;systemDesign&nbsp;-&nbsp;see&nbsp;<a href="#FGCPClient-LoadSystemDesign">LoadSystemDesign</a>()<br>
&nbsp;<br>
#design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
#design.load_file(filePath)<br>
design.build_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPClient-CreateSystem"><strong>CreateSystem</strong></a>(self, vsysName, vsysdescriptorName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Create&nbsp;VSystem&nbsp;based&nbsp;on&nbsp;descriptor&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;deployed<br>
&nbsp;<br>
vsysId&nbsp;=&nbsp;vdc.create_vsystem(vsysName,&nbsp;vsysdescriptorName,&nbsp;wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-DestroySystem"><strong>DestroySystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Destroy&nbsp;VSystem&nbsp;after&nbsp;stopping&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs<br>
&nbsp;<br>
vdc.destroy_vsystem(vsysName,&nbsp;wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-FindDiskImageByName"><strong>FindDiskImageByName</strong></a>(self, diskimageName)</dt><dd><tt>Find&nbsp;DiskImage&nbsp;by&nbsp;diskimageName<br>
&nbsp;<br>
diskimage&nbsp;=&nbsp;vdc.get_diskimage(diskimageName)</tt></dd></dl>

<dl><dt><a name="FGCPClient-FindServerTypeByName"><strong>FindServerTypeByName</strong></a>(self, name)</dt><dd><tt>Find&nbsp;ServerType&nbsp;by&nbsp;name<br>
&nbsp;<br>
servertype&nbsp;=&nbsp;vdc.get_servertype(name)</tt></dd></dl>

<dl><dt><a name="FGCPClient-FindVSYSDescriptorByName"><strong>FindVSYSDescriptorByName</strong></a>(self, vsysdescriptorName)</dt><dd><tt>Find&nbsp;VSYSDescriptor&nbsp;by&nbsp;vsysdescriptorName<br>
&nbsp;<br>
vsysdescriptor&nbsp;=&nbsp;vdc.get_vsysdescriptor(vsysdescriptorName)</tt></dd></dl>

<dl><dt><a name="FGCPClient-LoadSystemDesign"><strong>LoadSystemDesign</strong></a>(self, filePath, verbose<font color="#909090">=None</font>)</dt><dd><tt>Load&nbsp;VSystem&nbsp;design&nbsp;from&nbsp;file,&nbsp;for&nbsp;use&nbsp;e.g.&nbsp;in&nbsp;<a href="#FGCPClient-ConfigureSystem">ConfigureSystem</a>()<br>
&nbsp;<br>
design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
design.load_file(filePath)<br>
#design.build_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPClient-SaveSystemDesign"><strong>SaveSystemDesign</strong></a>(self, vsysName, filePath, verbose<font color="#909090">=None</font>)</dt><dd><tt>Save&nbsp;(fixed&nbsp;parts&nbsp;of)&nbsp;VSystem&nbsp;design&nbsp;to&nbsp;file<br>
&nbsp;<br>
design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
design.load_vsystem(vsysName)<br>
design.save_file(filePath)</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.client.html#FGCPOperator">FGCPOperator</a>:<br>
<dl><dt><a name="FGCPClient-AttachPublicIPAndWait"><strong>AttachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Attach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;attached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.attach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-BackupVDiskAndWait"><strong>BackupVDiskAndWait</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Take&nbsp;Backup&nbsp;of&nbsp;VDisk&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;finished&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.backup(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-BackupVServerAndRestart"><strong>BackupVServerAndRestart</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Backup&nbsp;all&nbsp;VDisks&nbsp;of&nbsp;a&nbsp;VServer&nbsp;and&nbsp;restart&nbsp;the&nbsp;VServer&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.backup(wait=True)<br>
for&nbsp;vdisk&nbsp;in&nbsp;vserver.list_vdisks():<br>
&nbsp;&nbsp;&nbsp;&nbsp;result&nbsp;=&nbsp;vdisk.backup(wait=True)<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-CleanupBackups"><strong>CleanupBackups</strong></a>(self, vsysId, vdiskId<font color="#909090">=None</font>)</dt><dd><tt>Clean&nbsp;up&nbsp;old&nbsp;VDisk&nbsp;backups&nbsp;e.g.&nbsp;to&nbsp;minimize&nbsp;disk&nbsp;space<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.cleanup_backups(max_num=100,&nbsp;max_age=None)</tt></dd></dl>

<dl><dt><a name="FGCPClient-DetachPublicIPAndWait"><strong>DetachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Detach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;detached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.detach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StartEFMAndWait"><strong>StartEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Start&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StartSystem"><strong>StartSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Start&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;started&nbsp;(TODO:&nbsp;define&nbsp;start&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.boot(wait=True)<br>
vsystem.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StartVServerAndWait"><strong>StartVServerAndWait</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Start&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StopEFMAndWait"><strong>StopEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Stop&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.stop(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StopSystem"><strong>StopSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;stopped&nbsp;(TODO:&nbsp;define&nbsp;stop&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.stop(wait=True)<br>
vsystem.shutdown(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPClient-StopVServerAndWait"><strong>StopVServerAndWait</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.stop(wait=True,&nbsp;force=None)</tt></dd></dl>

<dl><dt><a name="FGCPClient-check_status"><strong>check_status</strong></a>(self, done_status, pass_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;to&nbsp;see&nbsp;if&nbsp;we&nbsp;get&nbsp;done_status,&nbsp;or&nbsp;something&nbsp;other&nbsp;than&nbsp;pass_status<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<dl><dt><a name="FGCPClient-wait_for_status"><strong>wait_for_status</strong></a>(self, done_status, wait_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;repeatedly&nbsp;until&nbsp;we&nbsp;get&nbsp;done_status&nbsp;(or&nbsp;something&nbsp;else&nbsp;than&nbsp;wait_status)<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a>:<br>
<dl><dt><a name="FGCPClient-FindSystemByName"><strong>FindSystemByName</strong></a>(self, vsysName)</dt><dd><tt>Find&nbsp;VSystem&nbsp;by&nbsp;vsysName<br>
&nbsp;<br>
vsystem&nbsp;=&nbsp;vdc.get_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetSystemInventory"><strong>GetSystemInventory</strong></a>(self, vsysName<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;VSystem&nbsp;inventory&nbsp;(by&nbsp;vsysName)<br>
&nbsp;<br>
vsystems&nbsp;=&nbsp;vdc.list_vsystems()<br>
inventory&nbsp;=&nbsp;vsystem.get_inventory()</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetSystemStatus"><strong>GetSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, verbose<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
status&nbsp;=&nbsp;vsystem.get_status()</tt></dd></dl>

<dl><dt><a name="FGCPClient-ShowSystemStatus"><strong>ShowSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, sep<font color="#909090">='<font color="#c040c0">\t</font>'</font>)</dt><dd><tt>Show&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
vdc.show_vsystem_status()<br>
vsystem.<a href="#FGCPClient-show_status">show_status</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-getvdc"><strong>getvdc</strong></a>(self)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>:<br>
<dl><dt><a name="FGCPClient-AddAddressRange"><strong>AddAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPClient-AllocatePublicIP"><strong>AllocatePublicIP</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPClient-AttachPublicIP"><strong>AttachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPClient-AttachVDisk"><strong>AttachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPClient-BackupEFM"><strong>BackupEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPClient-BackupVDisk"><strong>BackupVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPClient-CreateAddressPool"><strong>CreateAddressPool</strong></a>(self, pipFrom<font color="#909090">=None</font>, pipTo<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPClient-CreateEFM"><strong>CreateEFM</strong></a>(self, vsysId, efmType, efmName, networkId)</dt><dd><tt>Usage:&nbsp;efmId&nbsp;=&nbsp;proxy.<a href="#FGCPClient-CreateEFM">CreateEFM</a>(self,&nbsp;vsys.vsysId,&nbsp;'SLB',&nbsp;'My&nbsp;LoadBalancer',&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPClient-CreateVDisk"><strong>CreateVDisk</strong></a>(self, vsysId, vdiskName, size)</dt><dd><tt>Usage:&nbsp;vdiskId&nbsp;=&nbsp;proxy.<a href="#FGCPClient-CreateVDisk">CreateVDisk</a>(self,&nbsp;vsys.vsysId,&nbsp;vdiskName,&nbsp;size)</tt></dd></dl>

<dl><dt><a name="FGCPClient-CreateVSYS"><strong>CreateVSYS</strong></a>(self, vsysDescriptorId, vsysName)</dt><dd><tt>Usage:&nbsp;vsysId&nbsp;=&nbsp;proxy.<a href="#FGCPClient-CreateVSYS">CreateVSYS</a>(vsysdescriptor.vsysdescriptorId,&nbsp;'My&nbsp;New&nbsp;System')</tt></dd></dl>

<dl><dt><a name="FGCPClient-CreateVServer"><strong>CreateVServer</strong></a>(self, vsysId, vserverName, vserverType, diskImageId, networkId)</dt><dd><tt>Usage:&nbsp;vserverId&nbsp;=&nbsp;proxy.<a href="#FGCPClient-CreateVServer">CreateVServer</a>(self,&nbsp;vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Server',&nbsp;servertype.name,&nbsp;diskimage.diskimageId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPClient-DeleteAddressRange"><strong>DeleteAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyEFM"><strong>DestroyEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyEFMBackup"><strong>DestroyEFMBackup</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyVDisk"><strong>DestroyVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyVDiskBackup"><strong>DestroyVDiskBackup</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyVSYS"><strong>DestroyVSYS</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPClient-DestroyVServer"><strong>DestroyVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPClient-DetachPublicIP"><strong>DetachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPClient-DetachVDisk"><strong>DetachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPClient-FreePublicIP"><strong>FreePublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPClient-GetAddressRange"><strong>GetAddressRange</strong></a>(self)</dt><dd><tt>Usage:&nbsp;addressranges&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetAddressRange">GetAddressRange</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetDiskImageAttributes"><strong>GetDiskImageAttributes</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;diskimage&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetDiskImageAttributes">GetDiskImageAttributes</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetEFMAttributes"><strong>GetEFMAttributes</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;efmattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetEFMAttributes">GetEFMAttributes</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetEFMConfigHandler"><strong>GetEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;GetEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPGetEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetEFMConfigHandler">GetEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_policy(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetEFMConfiguration"><strong>GetEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;GetEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetEFMStatus"><strong>GetEFMStatus</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetEFMStatus">GetEFMStatus</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetEventLog"><strong>GetEventLog</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;logs&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetEventLog">GetEventLog</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetInformation"><strong>GetInformation</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;infos&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetInformation">GetInformation</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetPerformanceInformation"><strong>GetPerformanceInformation</strong></a>(self, vsysId, vserverId, interval<font color="#909090">='10minute'</font>, dataType<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;perfinfos&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetPerformanceInformation">GetPerformanceInformation</a>(vsys.vsysId,&nbsp;vserver.vserverId,&nbsp;interval='hour')</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetPublicIPAttributes"><strong>GetPublicIPAttributes</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;publicipattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetPublicIPAttributes">GetPublicIPAttributes</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetPublicIPStatus"><strong>GetPublicIPStatus</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetPublicIPStatus">GetPublicIPStatus</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetSystemUsage"><strong>GetSystemUsage</strong></a>(self, vsysIds<font color="#909090">=None</font>)</dt><dd><tt>NOTE:&nbsp;extra&nbsp;'date'&nbsp;element&nbsp;on&nbsp;top-level&nbsp;compared&nbsp;to&nbsp;other&nbsp;API&nbsp;calls&nbsp;!<br>
Usage:&nbsp;date,&nbsp;usage&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetSystemUsage">GetSystemUsage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVDiskAttributes"><strong>GetVDiskAttributes</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;vdiskattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVDiskAttributes">GetVDiskAttributes</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVDiskStatus"><strong>GetVDiskStatus</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVDiskStatus">GetVDiskStatus</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVSYSAttributes"><strong>GetVSYSAttributes</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVSYSAttributes">GetVSYSAttributes</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVSYSConfiguration"><strong>GetVSYSConfiguration</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysconfig&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVSYSDescriptorAttributes"><strong>GetVSYSDescriptorAttributes</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVSYSDescriptorAttributes">GetVSYSDescriptorAttributes</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVSYSDescriptorConfiguration"><strong>GetVSYSDescriptorConfiguration</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorconfig&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVSYSDescriptorConfiguration">GetVSYSDescriptorConfiguration</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVSYSStatus"><strong>GetVSYSStatus</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVSYSStatus">GetVSYSStatus</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVServerAttributes"><strong>GetVServerAttributes</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverattr&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVServerAttributes">GetVServerAttributes</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVServerConfiguration"><strong>GetVServerConfiguration</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverconfig&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVServerConfiguration">GetVServerConfiguration</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVServerInitialPassword"><strong>GetVServerInitialPassword</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;initialpwd&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVServerInitialPassword">GetVServerInitialPassword</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-GetVServerStatus"><strong>GetVServerStatus</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetVServerStatus">GetVServerStatus</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListDiskImage"><strong>ListDiskImage</strong></a>(self, serverCategory<font color="#909090">=None</font>, vsysDescriptorId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;diskimages&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListDiskImage">ListDiskImage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListEFM"><strong>ListEFM</strong></a>(self, vsysId, efmType)</dt><dd><tt>Usage:<br>
firewalls&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"FW")<br>
loadbalancers&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"SLB")</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListEFMBackup"><strong>ListEFMBackup</strong></a>(self, vsysId, efmId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListEFMBackup">ListEFMBackup</a>(vsys.vsysId,&nbsp;firewall.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListPublicIP"><strong>ListPublicIP</strong></a>(self, vsysId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;publicips&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListPublicIP">ListPublicIP</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListServerType"><strong>ListServerType</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;servertypes&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListServerType">ListServerType</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListVDisk"><strong>ListVDisk</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vdisks&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListVDisk">ListVDisk</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListVDiskBackup"><strong>ListVDiskBackup</strong></a>(self, vsysId, vdiskId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListVDiskBackup">ListVDiskBackup</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListVSYS"><strong>ListVSYS</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsystems&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListVSYS">ListVSYS</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListVSYSDescriptor"><strong>ListVSYSDescriptor</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsysdescriptors&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListVSYSDescriptor">ListVSYSDescriptor</a>()</tt></dd></dl>

<dl><dt><a name="FGCPClient-ListVServer"><strong>ListVServer</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vservers&nbsp;=&nbsp;proxy.<a href="#FGCPClient-ListVServer">ListVServer</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPClient-RegisterPrivateDiskImage"><strong>RegisterPrivateDiskImage</strong></a>(self, vserverId, name, description)</dt></dl>

<dl><dt><a name="FGCPClient-RegisterPrivateVSYSDescriptor"><strong>RegisterPrivateVSYSDescriptor</strong></a>(self, vsysId, name, description, keyword, vservers)</dt><dd><tt>Usage:<br>
vsys&nbsp;=&nbsp;proxy.<a href="#FGCPClient-GetSystemInventory">GetSystemInventory</a>('My&nbsp;Existing&nbsp;VSYS')<br>
proxy.<a href="#FGCPClient-RegisterPrivateVSYSDescriptor">RegisterPrivateVSYSDescriptor</a>(vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Template',&nbsp;'This&nbsp;is&nbsp;a&nbsp;new&nbsp;template&nbsp;based&nbsp;on&nbsp;my&nbsp;existing&nbsp;VSYS',&nbsp;'some&nbsp;key&nbsp;words',&nbsp;vsys.vservers)</tt></dd></dl>

<dl><dt><a name="FGCPClient-RestoreEFM"><strong>RestoreEFM</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPClient-RestoreVDisk"><strong>RestoreVDisk</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPClient-StandByConsole"><strong>StandByConsole</strong></a>(self, vsysId, networkId)</dt><dd><tt>Usage:&nbsp;url&nbsp;=&nbsp;proxy.<a href="#FGCPClient-StandByConsole">StandByConsole</a>(vsys.vsysId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPClient-StartEFM"><strong>StartEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPClient-StartVServer"><strong>StartVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPClient-StopEFM"><strong>StopEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPClient-StopVServer"><strong>StopVServer</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPClient-UnregisterDiskImage"><strong>UnregisterDiskImage</strong></a>(self, diskImageId)</dt></dl>

<dl><dt><a name="FGCPClient-UnregisterPrivateVSYSDescriptor"><strong>UnregisterPrivateVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPClient-UnregisterVSYSDescriptor"><strong>UnregisterVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateDiskImageAttribute"><strong>UpdateDiskImageAttribute</strong></a>(self, diskImageId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateEFMAttribute"><strong>UpdateEFMAttribute</strong></a>(self, vsysId, efmId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateEFMConfigHandler"><strong>UpdateEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;UpdateEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPUpdateEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;proxy.<a href="#FGCPClient-UpdateEFMConfigHandler">UpdateEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_dns('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPClient-UpdateEFMConfiguration"><strong>UpdateEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;UpdateEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPClient-UpdateVDiskAttribute"><strong>UpdateVDiskAttribute</strong></a>(self, vsysId, vdiskId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateVSYSAttribute"><strong>UpdateVSYSAttribute</strong></a>(self, vsysId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateVSYSConfiguration"><strong>UpdateVSYSConfiguration</strong></a>(self, vsysId, configurationName, configurationValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateVSYSDescriptorAttribute"><strong>UpdateVSYSDescriptorAttribute</strong></a>(self, vsysDescriptorId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-UpdateVServerAttribute"><strong>UpdateVServerAttribute</strong></a>(self, vsysId, vserverId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPClient-set_verbose"><strong>set_verbose</strong></a>(self, verbose<font color="#909090">=None</font>)</dt><dd><tt>Show&nbsp;output&nbsp;(1),&nbsp;status&nbsp;checks&nbsp;(2)&nbsp;or&nbsp;nothing&nbsp;(0)</tt></dd></dl>

<dl><dt><a name="FGCPClient-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPClient-show_status"><strong>show_status</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><a name="FGCPClient-__init__"><strong>__init__</strong></a>(self, key_file<font color="#909090">='client.pem'</font>, region<font color="#909090">='de'</font>, verbose<font color="#909090">=0</font>, debug<font color="#909090">=0</font>, conn<font color="#909090">=None</font>)</dt><dd><tt>Use&nbsp;the&nbsp;same&nbsp;PEM&nbsp;file&nbsp;for&nbsp;SSL&nbsp;client&nbsp;certificate&nbsp;and&nbsp;RSA&nbsp;key&nbsp;signature<br>
&nbsp;<br>
Note:&nbsp;to&nbsp;convert&nbsp;your&nbsp;.p12&nbsp;or&nbsp;.pfx&nbsp;file&nbsp;to&nbsp;unencrypted&nbsp;PEM&nbsp;format,&nbsp;you&nbsp;can&nbsp;use<br>
the&nbsp;following&nbsp;'openssl'&nbsp;command:<br>
&nbsp;<br>
openssl&nbsp;pkcs12&nbsp;-in&nbsp;UserCert.p12&nbsp;-out&nbsp;client.pem&nbsp;-nodes</tt></dd></dl>

<dl><dt><a name="FGCPClient-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPClient-add_param"><strong>add_param</strong></a>(self, key<font color="#909090">=None</font>, value<font color="#909090">=None</font>, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPClient-close"><strong>close</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPClient-connect"><strong>connect</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPClient-do_action"><strong>do_action</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt><dd><tt>Send&nbsp;the&nbsp;XML-RPC&nbsp;request&nbsp;and&nbsp;get&nbsp;the&nbsp;response</tt></dd></dl>

<dl><dt><a name="FGCPClient-get_accesskeyid"><strong>get_accesskeyid</strong></a>(self)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPClient-get_body"><strong>get_body</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPClient-get_headers"><strong>get_headers</strong></a>(self, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPClient-get_signature"><strong>get_signature</strong></a>(self, acc<font color="#909090">=None</font>)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPClient-receive"><strong>receive</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPClient-send"><strong>send</strong></a>(self, method, uri, body, headers)</dt></dl>

<dl><dt><a name="FGCPClient-set_conn"><strong>set_conn</strong></a>(self, conn)</dt></dl>

<dl><dt><a name="FGCPClient-set_key"><strong>set_key</strong></a>(self, key_string)</dt></dl>

<dl><dt><a name="FGCPClient-set_region"><strong>set_region</strong></a>(self, region)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><strong>api_version</strong> = '2012-02-18'</dl>

<dl><dt><strong>debug</strong> = 0</dl>

<dl><dt><strong>key_file</strong> = 'client.pem'</dl>

<dl><dt><strong>locale</strong> = 'en'</dl>

<dl><dt><strong>region</strong> = 'de'</dl>

<dl><dt><strong>timezone</strong> = 'Central European Time'</dl>

<dl><dt><strong>uri</strong> = '/ovissapi/endpoint'</dl>

<dl><dt><strong>user_agent</strong> = 'OViSS-API-CLIENT'</dl>

<dl><dt><strong>verbose</strong> = 0</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPClientError">class <strong>FGCPClientError</strong></a>(<a href="fgcp.html#FGCPError">fgcp.FGCPError</a>)</font></td></tr>
    
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.client.html#FGCPClientError">FGCPClientError</a></dd>
<dd><a href="fgcp.html#FGCPError">fgcp.FGCPError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="fgcp.html#FGCPError">fgcp.FGCPError</a>:<br>
<dl><dt><a name="FGCPClientError-__init__"><strong>__init__</strong></a>(self, status, message)</dt></dl>

<dl><dt><a name="FGCPClientError-__str__"><strong>__str__</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from <a href="fgcp.html#FGCPError">fgcp.FGCPError</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#FGCPClientError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>

<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="FGCPClientError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
&nbsp;<br>
Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPClientError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPClientError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>

<dl><dt><a name="FGCPClientError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPClientError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>

<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPDesigner">class <strong>FGCPDesigner</strong></a>(<a href="fgcp.client.html#FGCPOperator">FGCPOperator</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>FGCP&nbsp;Designer&nbsp;Methods<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.client.html#FGCPDesigner">FGCPDesigner</a></dd>
<dd><a href="fgcp.client.html#FGCPOperator">FGCPOperator</a></dd>
<dd><a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a></dd>
<dd><a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a></dd>
<dd><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a></dd>
<dd><a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPDesigner-ConfigureSystem"><strong>ConfigureSystem</strong></a>(self, vsysName, systemDesign, verbose<font color="#909090">=None</font>)</dt><dd><tt>Configure&nbsp;VSystem&nbsp;based&nbsp;on&nbsp;some&nbsp;systemDesign&nbsp;-&nbsp;see&nbsp;<a href="#FGCPDesigner-LoadSystemDesign">LoadSystemDesign</a>()<br>
&nbsp;<br>
#design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
#design.load_file(filePath)<br>
design.build_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-CreateSystem"><strong>CreateSystem</strong></a>(self, vsysName, vsysdescriptorName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Create&nbsp;VSystem&nbsp;based&nbsp;on&nbsp;descriptor&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;deployed<br>
&nbsp;<br>
vsysId&nbsp;=&nbsp;vdc.create_vsystem(vsysName,&nbsp;vsysdescriptorName,&nbsp;wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-DestroySystem"><strong>DestroySystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Destroy&nbsp;VSystem&nbsp;after&nbsp;stopping&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs<br>
&nbsp;<br>
vdc.destroy_vsystem(vsysName,&nbsp;wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-FindDiskImageByName"><strong>FindDiskImageByName</strong></a>(self, diskimageName)</dt><dd><tt>Find&nbsp;DiskImage&nbsp;by&nbsp;diskimageName<br>
&nbsp;<br>
diskimage&nbsp;=&nbsp;vdc.get_diskimage(diskimageName)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-FindServerTypeByName"><strong>FindServerTypeByName</strong></a>(self, name)</dt><dd><tt>Find&nbsp;ServerType&nbsp;by&nbsp;name<br>
&nbsp;<br>
servertype&nbsp;=&nbsp;vdc.get_servertype(name)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-FindVSYSDescriptorByName"><strong>FindVSYSDescriptorByName</strong></a>(self, vsysdescriptorName)</dt><dd><tt>Find&nbsp;VSYSDescriptor&nbsp;by&nbsp;vsysdescriptorName<br>
&nbsp;<br>
vsysdescriptor&nbsp;=&nbsp;vdc.get_vsysdescriptor(vsysdescriptorName)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-LoadSystemDesign"><strong>LoadSystemDesign</strong></a>(self, filePath, verbose<font color="#909090">=None</font>)</dt><dd><tt>Load&nbsp;VSystem&nbsp;design&nbsp;from&nbsp;file,&nbsp;for&nbsp;use&nbsp;e.g.&nbsp;in&nbsp;<a href="#FGCPDesigner-ConfigureSystem">ConfigureSystem</a>()<br>
&nbsp;<br>
design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
design.load_file(filePath)<br>
#design.build_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-SaveSystemDesign"><strong>SaveSystemDesign</strong></a>(self, vsysName, filePath, verbose<font color="#909090">=None</font>)</dt><dd><tt>Save&nbsp;(fixed&nbsp;parts&nbsp;of)&nbsp;VSystem&nbsp;design&nbsp;to&nbsp;file<br>
&nbsp;<br>
design&nbsp;=&nbsp;vdc.get_vsystem_design()<br>
design.load_vsystem(vsysName)<br>
design.save_file(filePath)</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.client.html#FGCPOperator">FGCPOperator</a>:<br>
<dl><dt><a name="FGCPDesigner-AttachPublicIPAndWait"><strong>AttachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Attach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;attached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.attach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-BackupVDiskAndWait"><strong>BackupVDiskAndWait</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Take&nbsp;Backup&nbsp;of&nbsp;VDisk&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;finished&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.backup(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-BackupVServerAndRestart"><strong>BackupVServerAndRestart</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Backup&nbsp;all&nbsp;VDisks&nbsp;of&nbsp;a&nbsp;VServer&nbsp;and&nbsp;restart&nbsp;the&nbsp;VServer&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.backup(wait=True)<br>
for&nbsp;vdisk&nbsp;in&nbsp;vserver.list_vdisks():<br>
&nbsp;&nbsp;&nbsp;&nbsp;result&nbsp;=&nbsp;vdisk.backup(wait=True)<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-CleanupBackups"><strong>CleanupBackups</strong></a>(self, vsysId, vdiskId<font color="#909090">=None</font>)</dt><dd><tt>Clean&nbsp;up&nbsp;old&nbsp;VDisk&nbsp;backups&nbsp;e.g.&nbsp;to&nbsp;minimize&nbsp;disk&nbsp;space<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.cleanup_backups(max_num=100,&nbsp;max_age=None)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-DetachPublicIPAndWait"><strong>DetachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Detach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;detached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.detach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StartEFMAndWait"><strong>StartEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Start&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StartSystem"><strong>StartSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Start&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;started&nbsp;(TODO:&nbsp;define&nbsp;start&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.boot(wait=True)<br>
vsystem.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StartVServerAndWait"><strong>StartVServerAndWait</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Start&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StopEFMAndWait"><strong>StopEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Stop&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.stop(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StopSystem"><strong>StopSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;stopped&nbsp;(TODO:&nbsp;define&nbsp;stop&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.stop(wait=True)<br>
vsystem.shutdown(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StopVServerAndWait"><strong>StopVServerAndWait</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.stop(wait=True,&nbsp;force=None)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-check_status"><strong>check_status</strong></a>(self, done_status, pass_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;to&nbsp;see&nbsp;if&nbsp;we&nbsp;get&nbsp;done_status,&nbsp;or&nbsp;something&nbsp;other&nbsp;than&nbsp;pass_status<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-wait_for_status"><strong>wait_for_status</strong></a>(self, done_status, wait_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;repeatedly&nbsp;until&nbsp;we&nbsp;get&nbsp;done_status&nbsp;(or&nbsp;something&nbsp;else&nbsp;than&nbsp;wait_status)<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a>:<br>
<dl><dt><a name="FGCPDesigner-FindSystemByName"><strong>FindSystemByName</strong></a>(self, vsysName)</dt><dd><tt>Find&nbsp;VSystem&nbsp;by&nbsp;vsysName<br>
&nbsp;<br>
vsystem&nbsp;=&nbsp;vdc.get_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetSystemInventory"><strong>GetSystemInventory</strong></a>(self, vsysName<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;VSystem&nbsp;inventory&nbsp;(by&nbsp;vsysName)<br>
&nbsp;<br>
vsystems&nbsp;=&nbsp;vdc.list_vsystems()<br>
inventory&nbsp;=&nbsp;vsystem.get_inventory()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetSystemStatus"><strong>GetSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, verbose<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
status&nbsp;=&nbsp;vsystem.get_status()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ShowSystemStatus"><strong>ShowSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, sep<font color="#909090">='<font color="#c040c0">\t</font>'</font>)</dt><dd><tt>Show&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
vdc.show_vsystem_status()<br>
vsystem.<a href="#FGCPDesigner-show_status">show_status</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-getvdc"><strong>getvdc</strong></a>(self)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>:<br>
<dl><dt><a name="FGCPDesigner-AddAddressRange"><strong>AddAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPDesigner-AllocatePublicIP"><strong>AllocatePublicIP</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPDesigner-AttachPublicIP"><strong>AttachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPDesigner-AttachVDisk"><strong>AttachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPDesigner-BackupEFM"><strong>BackupEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPDesigner-BackupVDisk"><strong>BackupVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPDesigner-CreateAddressPool"><strong>CreateAddressPool</strong></a>(self, pipFrom<font color="#909090">=None</font>, pipTo<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-CreateEFM"><strong>CreateEFM</strong></a>(self, vsysId, efmType, efmName, networkId)</dt><dd><tt>Usage:&nbsp;efmId&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-CreateEFM">CreateEFM</a>(self,&nbsp;vsys.vsysId,&nbsp;'SLB',&nbsp;'My&nbsp;LoadBalancer',&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-CreateVDisk"><strong>CreateVDisk</strong></a>(self, vsysId, vdiskName, size)</dt><dd><tt>Usage:&nbsp;vdiskId&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-CreateVDisk">CreateVDisk</a>(self,&nbsp;vsys.vsysId,&nbsp;vdiskName,&nbsp;size)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-CreateVSYS"><strong>CreateVSYS</strong></a>(self, vsysDescriptorId, vsysName)</dt><dd><tt>Usage:&nbsp;vsysId&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-CreateVSYS">CreateVSYS</a>(vsysdescriptor.vsysdescriptorId,&nbsp;'My&nbsp;New&nbsp;System')</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-CreateVServer"><strong>CreateVServer</strong></a>(self, vsysId, vserverName, vserverType, diskImageId, networkId)</dt><dd><tt>Usage:&nbsp;vserverId&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-CreateVServer">CreateVServer</a>(self,&nbsp;vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Server',&nbsp;servertype.name,&nbsp;diskimage.diskimageId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-DeleteAddressRange"><strong>DeleteAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyEFM"><strong>DestroyEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyEFMBackup"><strong>DestroyEFMBackup</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyVDisk"><strong>DestroyVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyVDiskBackup"><strong>DestroyVDiskBackup</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyVSYS"><strong>DestroyVSYS</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DestroyVServer"><strong>DestroyVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPDesigner-DetachPublicIP"><strong>DetachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPDesigner-DetachVDisk"><strong>DetachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPDesigner-FreePublicIP"><strong>FreePublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPDesigner-GetAddressRange"><strong>GetAddressRange</strong></a>(self)</dt><dd><tt>Usage:&nbsp;addressranges&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetAddressRange">GetAddressRange</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetDiskImageAttributes"><strong>GetDiskImageAttributes</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;diskimage&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetDiskImageAttributes">GetDiskImageAttributes</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetEFMAttributes"><strong>GetEFMAttributes</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;efmattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetEFMAttributes">GetEFMAttributes</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetEFMConfigHandler"><strong>GetEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;GetEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPGetEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetEFMConfigHandler">GetEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_policy(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetEFMConfiguration"><strong>GetEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;GetEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetEFMStatus"><strong>GetEFMStatus</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetEFMStatus">GetEFMStatus</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetEventLog"><strong>GetEventLog</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;logs&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetEventLog">GetEventLog</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetInformation"><strong>GetInformation</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;infos&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetInformation">GetInformation</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetPerformanceInformation"><strong>GetPerformanceInformation</strong></a>(self, vsysId, vserverId, interval<font color="#909090">='10minute'</font>, dataType<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;perfinfos&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetPerformanceInformation">GetPerformanceInformation</a>(vsys.vsysId,&nbsp;vserver.vserverId,&nbsp;interval='hour')</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetPublicIPAttributes"><strong>GetPublicIPAttributes</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;publicipattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetPublicIPAttributes">GetPublicIPAttributes</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetPublicIPStatus"><strong>GetPublicIPStatus</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetPublicIPStatus">GetPublicIPStatus</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetSystemUsage"><strong>GetSystemUsage</strong></a>(self, vsysIds<font color="#909090">=None</font>)</dt><dd><tt>NOTE:&nbsp;extra&nbsp;'date'&nbsp;element&nbsp;on&nbsp;top-level&nbsp;compared&nbsp;to&nbsp;other&nbsp;API&nbsp;calls&nbsp;!<br>
Usage:&nbsp;date,&nbsp;usage&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetSystemUsage">GetSystemUsage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVDiskAttributes"><strong>GetVDiskAttributes</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;vdiskattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVDiskAttributes">GetVDiskAttributes</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVDiskStatus"><strong>GetVDiskStatus</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVDiskStatus">GetVDiskStatus</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVSYSAttributes"><strong>GetVSYSAttributes</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVSYSAttributes">GetVSYSAttributes</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVSYSConfiguration"><strong>GetVSYSConfiguration</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysconfig&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVSYSDescriptorAttributes"><strong>GetVSYSDescriptorAttributes</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVSYSDescriptorAttributes">GetVSYSDescriptorAttributes</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVSYSDescriptorConfiguration"><strong>GetVSYSDescriptorConfiguration</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorconfig&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVSYSDescriptorConfiguration">GetVSYSDescriptorConfiguration</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVSYSStatus"><strong>GetVSYSStatus</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVSYSStatus">GetVSYSStatus</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVServerAttributes"><strong>GetVServerAttributes</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverattr&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVServerAttributes">GetVServerAttributes</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVServerConfiguration"><strong>GetVServerConfiguration</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverconfig&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVServerConfiguration">GetVServerConfiguration</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVServerInitialPassword"><strong>GetVServerInitialPassword</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;initialpwd&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVServerInitialPassword">GetVServerInitialPassword</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-GetVServerStatus"><strong>GetVServerStatus</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetVServerStatus">GetVServerStatus</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListDiskImage"><strong>ListDiskImage</strong></a>(self, serverCategory<font color="#909090">=None</font>, vsysDescriptorId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;diskimages&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListDiskImage">ListDiskImage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListEFM"><strong>ListEFM</strong></a>(self, vsysId, efmType)</dt><dd><tt>Usage:<br>
firewalls&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"FW")<br>
loadbalancers&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"SLB")</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListEFMBackup"><strong>ListEFMBackup</strong></a>(self, vsysId, efmId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListEFMBackup">ListEFMBackup</a>(vsys.vsysId,&nbsp;firewall.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListPublicIP"><strong>ListPublicIP</strong></a>(self, vsysId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;publicips&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListPublicIP">ListPublicIP</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListServerType"><strong>ListServerType</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;servertypes&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListServerType">ListServerType</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListVDisk"><strong>ListVDisk</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vdisks&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListVDisk">ListVDisk</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListVDiskBackup"><strong>ListVDiskBackup</strong></a>(self, vsysId, vdiskId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListVDiskBackup">ListVDiskBackup</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListVSYS"><strong>ListVSYS</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsystems&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListVSYS">ListVSYS</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListVSYSDescriptor"><strong>ListVSYSDescriptor</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsysdescriptors&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListVSYSDescriptor">ListVSYSDescriptor</a>()</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-ListVServer"><strong>ListVServer</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vservers&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-ListVServer">ListVServer</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-RegisterPrivateDiskImage"><strong>RegisterPrivateDiskImage</strong></a>(self, vserverId, name, description)</dt></dl>

<dl><dt><a name="FGCPDesigner-RegisterPrivateVSYSDescriptor"><strong>RegisterPrivateVSYSDescriptor</strong></a>(self, vsysId, name, description, keyword, vservers)</dt><dd><tt>Usage:<br>
vsys&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-GetSystemInventory">GetSystemInventory</a>('My&nbsp;Existing&nbsp;VSYS')<br>
proxy.<a href="#FGCPDesigner-RegisterPrivateVSYSDescriptor">RegisterPrivateVSYSDescriptor</a>(vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Template',&nbsp;'This&nbsp;is&nbsp;a&nbsp;new&nbsp;template&nbsp;based&nbsp;on&nbsp;my&nbsp;existing&nbsp;VSYS',&nbsp;'some&nbsp;key&nbsp;words',&nbsp;vsys.vservers)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-RestoreEFM"><strong>RestoreEFM</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPDesigner-RestoreVDisk"><strong>RestoreVDisk</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPDesigner-StandByConsole"><strong>StandByConsole</strong></a>(self, vsysId, networkId)</dt><dd><tt>Usage:&nbsp;url&nbsp;=&nbsp;proxy.<a href="#FGCPDesigner-StandByConsole">StandByConsole</a>(vsys.vsysId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-StartEFM"><strong>StartEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPDesigner-StartVServer"><strong>StartVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPDesigner-StopEFM"><strong>StopEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPDesigner-StopVServer"><strong>StopVServer</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-UnregisterDiskImage"><strong>UnregisterDiskImage</strong></a>(self, diskImageId)</dt></dl>

<dl><dt><a name="FGCPDesigner-UnregisterPrivateVSYSDescriptor"><strong>UnregisterPrivateVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPDesigner-UnregisterVSYSDescriptor"><strong>UnregisterVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateDiskImageAttribute"><strong>UpdateDiskImageAttribute</strong></a>(self, diskImageId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateEFMAttribute"><strong>UpdateEFMAttribute</strong></a>(self, vsysId, efmId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateEFMConfigHandler"><strong>UpdateEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;UpdateEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPUpdateEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;proxy.<a href="#FGCPDesigner-UpdateEFMConfigHandler">UpdateEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_dns('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-UpdateEFMConfiguration"><strong>UpdateEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;UpdateEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-UpdateVDiskAttribute"><strong>UpdateVDiskAttribute</strong></a>(self, vsysId, vdiskId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateVSYSAttribute"><strong>UpdateVSYSAttribute</strong></a>(self, vsysId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateVSYSConfiguration"><strong>UpdateVSYSConfiguration</strong></a>(self, vsysId, configurationName, configurationValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateVSYSDescriptorAttribute"><strong>UpdateVSYSDescriptorAttribute</strong></a>(self, vsysDescriptorId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-UpdateVServerAttribute"><strong>UpdateVServerAttribute</strong></a>(self, vsysId, vserverId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPDesigner-set_verbose"><strong>set_verbose</strong></a>(self, verbose<font color="#909090">=None</font>)</dt><dd><tt>Show&nbsp;output&nbsp;(1),&nbsp;status&nbsp;checks&nbsp;(2)&nbsp;or&nbsp;nothing&nbsp;(0)</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-show_status"><strong>show_status</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><a name="FGCPDesigner-__init__"><strong>__init__</strong></a>(self, key_file<font color="#909090">='client.pem'</font>, region<font color="#909090">='de'</font>, verbose<font color="#909090">=0</font>, debug<font color="#909090">=0</font>, conn<font color="#909090">=None</font>)</dt><dd><tt>Use&nbsp;the&nbsp;same&nbsp;PEM&nbsp;file&nbsp;for&nbsp;SSL&nbsp;client&nbsp;certificate&nbsp;and&nbsp;RSA&nbsp;key&nbsp;signature<br>
&nbsp;<br>
Note:&nbsp;to&nbsp;convert&nbsp;your&nbsp;.p12&nbsp;or&nbsp;.pfx&nbsp;file&nbsp;to&nbsp;unencrypted&nbsp;PEM&nbsp;format,&nbsp;you&nbsp;can&nbsp;use<br>
the&nbsp;following&nbsp;'openssl'&nbsp;command:<br>
&nbsp;<br>
openssl&nbsp;pkcs12&nbsp;-in&nbsp;UserCert.p12&nbsp;-out&nbsp;client.pem&nbsp;-nodes</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesigner-add_param"><strong>add_param</strong></a>(self, key<font color="#909090">=None</font>, value<font color="#909090">=None</font>, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-close"><strong>close</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesigner-connect"><strong>connect</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesigner-do_action"><strong>do_action</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt><dd><tt>Send&nbsp;the&nbsp;XML-RPC&nbsp;request&nbsp;and&nbsp;get&nbsp;the&nbsp;response</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-get_accesskeyid"><strong>get_accesskeyid</strong></a>(self)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-get_body"><strong>get_body</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-get_headers"><strong>get_headers</strong></a>(self, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesigner-get_signature"><strong>get_signature</strong></a>(self, acc<font color="#909090">=None</font>)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPDesigner-receive"><strong>receive</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesigner-send"><strong>send</strong></a>(self, method, uri, body, headers)</dt></dl>

<dl><dt><a name="FGCPDesigner-set_conn"><strong>set_conn</strong></a>(self, conn)</dt></dl>

<dl><dt><a name="FGCPDesigner-set_key"><strong>set_key</strong></a>(self, key_string)</dt></dl>

<dl><dt><a name="FGCPDesigner-set_region"><strong>set_region</strong></a>(self, region)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><strong>api_version</strong> = '2012-02-18'</dl>

<dl><dt><strong>debug</strong> = 0</dl>

<dl><dt><strong>key_file</strong> = 'client.pem'</dl>

<dl><dt><strong>locale</strong> = 'en'</dl>

<dl><dt><strong>region</strong> = 'de'</dl>

<dl><dt><strong>timezone</strong> = 'Central European Time'</dl>

<dl><dt><strong>uri</strong> = '/ovissapi/endpoint'</dl>

<dl><dt><strong>user_agent</strong> = 'OViSS-API-CLIENT'</dl>

<dl><dt><strong>verbose</strong> = 0</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPMonitor">class <strong>FGCPMonitor</strong></a>(<a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>FGCP&nbsp;Monitoring&nbsp;Methods<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a></dd>
<dd><a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a></dd>
<dd><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a></dd>
<dd><a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPMonitor-FindSystemByName"><strong>FindSystemByName</strong></a>(self, vsysName)</dt><dd><tt>Find&nbsp;VSystem&nbsp;by&nbsp;vsysName<br>
&nbsp;<br>
vsystem&nbsp;=&nbsp;vdc.get_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetSystemInventory"><strong>GetSystemInventory</strong></a>(self, vsysName<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;VSystem&nbsp;inventory&nbsp;(by&nbsp;vsysName)<br>
&nbsp;<br>
vsystems&nbsp;=&nbsp;vdc.list_vsystems()<br>
inventory&nbsp;=&nbsp;vsystem.get_inventory()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetSystemStatus"><strong>GetSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, verbose<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
status&nbsp;=&nbsp;vsystem.get_status()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ShowSystemStatus"><strong>ShowSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, sep<font color="#909090">='<font color="#c040c0">\t</font>'</font>)</dt><dd><tt>Show&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
vdc.show_vsystem_status()<br>
vsystem.<a href="#FGCPMonitor-show_status">show_status</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-getvdc"><strong>getvdc</strong></a>(self)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>:<br>
<dl><dt><a name="FGCPMonitor-AddAddressRange"><strong>AddAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPMonitor-AllocatePublicIP"><strong>AllocatePublicIP</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPMonitor-AttachPublicIP"><strong>AttachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPMonitor-AttachVDisk"><strong>AttachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPMonitor-BackupEFM"><strong>BackupEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPMonitor-BackupVDisk"><strong>BackupVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPMonitor-CreateAddressPool"><strong>CreateAddressPool</strong></a>(self, pipFrom<font color="#909090">=None</font>, pipTo<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-CreateEFM"><strong>CreateEFM</strong></a>(self, vsysId, efmType, efmName, networkId)</dt><dd><tt>Usage:&nbsp;efmId&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-CreateEFM">CreateEFM</a>(self,&nbsp;vsys.vsysId,&nbsp;'SLB',&nbsp;'My&nbsp;LoadBalancer',&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-CreateVDisk"><strong>CreateVDisk</strong></a>(self, vsysId, vdiskName, size)</dt><dd><tt>Usage:&nbsp;vdiskId&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-CreateVDisk">CreateVDisk</a>(self,&nbsp;vsys.vsysId,&nbsp;vdiskName,&nbsp;size)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-CreateVSYS"><strong>CreateVSYS</strong></a>(self, vsysDescriptorId, vsysName)</dt><dd><tt>Usage:&nbsp;vsysId&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-CreateVSYS">CreateVSYS</a>(vsysdescriptor.vsysdescriptorId,&nbsp;'My&nbsp;New&nbsp;System')</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-CreateVServer"><strong>CreateVServer</strong></a>(self, vsysId, vserverName, vserverType, diskImageId, networkId)</dt><dd><tt>Usage:&nbsp;vserverId&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-CreateVServer">CreateVServer</a>(self,&nbsp;vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Server',&nbsp;servertype.name,&nbsp;diskimage.diskimageId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-DeleteAddressRange"><strong>DeleteAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyEFM"><strong>DestroyEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyEFMBackup"><strong>DestroyEFMBackup</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyVDisk"><strong>DestroyVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyVDiskBackup"><strong>DestroyVDiskBackup</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyVSYS"><strong>DestroyVSYS</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DestroyVServer"><strong>DestroyVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPMonitor-DetachPublicIP"><strong>DetachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPMonitor-DetachVDisk"><strong>DetachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPMonitor-FreePublicIP"><strong>FreePublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPMonitor-GetAddressRange"><strong>GetAddressRange</strong></a>(self)</dt><dd><tt>Usage:&nbsp;addressranges&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetAddressRange">GetAddressRange</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetDiskImageAttributes"><strong>GetDiskImageAttributes</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;diskimage&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetDiskImageAttributes">GetDiskImageAttributes</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetEFMAttributes"><strong>GetEFMAttributes</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;efmattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetEFMAttributes">GetEFMAttributes</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetEFMConfigHandler"><strong>GetEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;GetEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPGetEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetEFMConfigHandler">GetEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_policy(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetEFMConfiguration"><strong>GetEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;GetEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetEFMStatus"><strong>GetEFMStatus</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetEFMStatus">GetEFMStatus</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetEventLog"><strong>GetEventLog</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;logs&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetEventLog">GetEventLog</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetInformation"><strong>GetInformation</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;infos&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetInformation">GetInformation</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetPerformanceInformation"><strong>GetPerformanceInformation</strong></a>(self, vsysId, vserverId, interval<font color="#909090">='10minute'</font>, dataType<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;perfinfos&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetPerformanceInformation">GetPerformanceInformation</a>(vsys.vsysId,&nbsp;vserver.vserverId,&nbsp;interval='hour')</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetPublicIPAttributes"><strong>GetPublicIPAttributes</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;publicipattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetPublicIPAttributes">GetPublicIPAttributes</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetPublicIPStatus"><strong>GetPublicIPStatus</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetPublicIPStatus">GetPublicIPStatus</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetSystemUsage"><strong>GetSystemUsage</strong></a>(self, vsysIds<font color="#909090">=None</font>)</dt><dd><tt>NOTE:&nbsp;extra&nbsp;'date'&nbsp;element&nbsp;on&nbsp;top-level&nbsp;compared&nbsp;to&nbsp;other&nbsp;API&nbsp;calls&nbsp;!<br>
Usage:&nbsp;date,&nbsp;usage&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetSystemUsage">GetSystemUsage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVDiskAttributes"><strong>GetVDiskAttributes</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;vdiskattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVDiskAttributes">GetVDiskAttributes</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVDiskStatus"><strong>GetVDiskStatus</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVDiskStatus">GetVDiskStatus</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVSYSAttributes"><strong>GetVSYSAttributes</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVSYSAttributes">GetVSYSAttributes</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVSYSConfiguration"><strong>GetVSYSConfiguration</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysconfig&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVSYSDescriptorAttributes"><strong>GetVSYSDescriptorAttributes</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVSYSDescriptorAttributes">GetVSYSDescriptorAttributes</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVSYSDescriptorConfiguration"><strong>GetVSYSDescriptorConfiguration</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorconfig&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVSYSDescriptorConfiguration">GetVSYSDescriptorConfiguration</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVSYSStatus"><strong>GetVSYSStatus</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVSYSStatus">GetVSYSStatus</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVServerAttributes"><strong>GetVServerAttributes</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverattr&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVServerAttributes">GetVServerAttributes</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVServerConfiguration"><strong>GetVServerConfiguration</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverconfig&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVServerConfiguration">GetVServerConfiguration</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVServerInitialPassword"><strong>GetVServerInitialPassword</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;initialpwd&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVServerInitialPassword">GetVServerInitialPassword</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-GetVServerStatus"><strong>GetVServerStatus</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetVServerStatus">GetVServerStatus</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListDiskImage"><strong>ListDiskImage</strong></a>(self, serverCategory<font color="#909090">=None</font>, vsysDescriptorId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;diskimages&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListDiskImage">ListDiskImage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListEFM"><strong>ListEFM</strong></a>(self, vsysId, efmType)</dt><dd><tt>Usage:<br>
firewalls&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"FW")<br>
loadbalancers&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"SLB")</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListEFMBackup"><strong>ListEFMBackup</strong></a>(self, vsysId, efmId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListEFMBackup">ListEFMBackup</a>(vsys.vsysId,&nbsp;firewall.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListPublicIP"><strong>ListPublicIP</strong></a>(self, vsysId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;publicips&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListPublicIP">ListPublicIP</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListServerType"><strong>ListServerType</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;servertypes&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListServerType">ListServerType</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListVDisk"><strong>ListVDisk</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vdisks&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListVDisk">ListVDisk</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListVDiskBackup"><strong>ListVDiskBackup</strong></a>(self, vsysId, vdiskId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListVDiskBackup">ListVDiskBackup</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListVSYS"><strong>ListVSYS</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsystems&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListVSYS">ListVSYS</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListVSYSDescriptor"><strong>ListVSYSDescriptor</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsysdescriptors&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListVSYSDescriptor">ListVSYSDescriptor</a>()</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-ListVServer"><strong>ListVServer</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vservers&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-ListVServer">ListVServer</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-RegisterPrivateDiskImage"><strong>RegisterPrivateDiskImage</strong></a>(self, vserverId, name, description)</dt></dl>

<dl><dt><a name="FGCPMonitor-RegisterPrivateVSYSDescriptor"><strong>RegisterPrivateVSYSDescriptor</strong></a>(self, vsysId, name, description, keyword, vservers)</dt><dd><tt>Usage:<br>
vsys&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-GetSystemInventory">GetSystemInventory</a>('My&nbsp;Existing&nbsp;VSYS')<br>
proxy.<a href="#FGCPMonitor-RegisterPrivateVSYSDescriptor">RegisterPrivateVSYSDescriptor</a>(vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Template',&nbsp;'This&nbsp;is&nbsp;a&nbsp;new&nbsp;template&nbsp;based&nbsp;on&nbsp;my&nbsp;existing&nbsp;VSYS',&nbsp;'some&nbsp;key&nbsp;words',&nbsp;vsys.vservers)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-RestoreEFM"><strong>RestoreEFM</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPMonitor-RestoreVDisk"><strong>RestoreVDisk</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPMonitor-StandByConsole"><strong>StandByConsole</strong></a>(self, vsysId, networkId)</dt><dd><tt>Usage:&nbsp;url&nbsp;=&nbsp;proxy.<a href="#FGCPMonitor-StandByConsole">StandByConsole</a>(vsys.vsysId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-StartEFM"><strong>StartEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPMonitor-StartVServer"><strong>StartVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPMonitor-StopEFM"><strong>StopEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPMonitor-StopVServer"><strong>StopVServer</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-UnregisterDiskImage"><strong>UnregisterDiskImage</strong></a>(self, diskImageId)</dt></dl>

<dl><dt><a name="FGCPMonitor-UnregisterPrivateVSYSDescriptor"><strong>UnregisterPrivateVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPMonitor-UnregisterVSYSDescriptor"><strong>UnregisterVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateDiskImageAttribute"><strong>UpdateDiskImageAttribute</strong></a>(self, diskImageId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateEFMAttribute"><strong>UpdateEFMAttribute</strong></a>(self, vsysId, efmId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateEFMConfigHandler"><strong>UpdateEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;UpdateEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPUpdateEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;proxy.<a href="#FGCPMonitor-UpdateEFMConfigHandler">UpdateEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_dns('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-UpdateEFMConfiguration"><strong>UpdateEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;UpdateEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-UpdateVDiskAttribute"><strong>UpdateVDiskAttribute</strong></a>(self, vsysId, vdiskId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateVSYSAttribute"><strong>UpdateVSYSAttribute</strong></a>(self, vsysId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateVSYSConfiguration"><strong>UpdateVSYSConfiguration</strong></a>(self, vsysId, configurationName, configurationValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateVSYSDescriptorAttribute"><strong>UpdateVSYSDescriptorAttribute</strong></a>(self, vsysDescriptorId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-UpdateVServerAttribute"><strong>UpdateVServerAttribute</strong></a>(self, vsysId, vserverId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPMonitor-set_verbose"><strong>set_verbose</strong></a>(self, verbose<font color="#909090">=None</font>)</dt><dd><tt>Show&nbsp;output&nbsp;(1),&nbsp;status&nbsp;checks&nbsp;(2)&nbsp;or&nbsp;nothing&nbsp;(0)</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-show_status"><strong>show_status</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><a name="FGCPMonitor-__init__"><strong>__init__</strong></a>(self, key_file<font color="#909090">='client.pem'</font>, region<font color="#909090">='de'</font>, verbose<font color="#909090">=0</font>, debug<font color="#909090">=0</font>, conn<font color="#909090">=None</font>)</dt><dd><tt>Use&nbsp;the&nbsp;same&nbsp;PEM&nbsp;file&nbsp;for&nbsp;SSL&nbsp;client&nbsp;certificate&nbsp;and&nbsp;RSA&nbsp;key&nbsp;signature<br>
&nbsp;<br>
Note:&nbsp;to&nbsp;convert&nbsp;your&nbsp;.p12&nbsp;or&nbsp;.pfx&nbsp;file&nbsp;to&nbsp;unencrypted&nbsp;PEM&nbsp;format,&nbsp;you&nbsp;can&nbsp;use<br>
the&nbsp;following&nbsp;'openssl'&nbsp;command:<br>
&nbsp;<br>
openssl&nbsp;pkcs12&nbsp;-in&nbsp;UserCert.p12&nbsp;-out&nbsp;client.pem&nbsp;-nodes</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPMonitor-add_param"><strong>add_param</strong></a>(self, key<font color="#909090">=None</font>, value<font color="#909090">=None</font>, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-close"><strong>close</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPMonitor-connect"><strong>connect</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPMonitor-do_action"><strong>do_action</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt><dd><tt>Send&nbsp;the&nbsp;XML-RPC&nbsp;request&nbsp;and&nbsp;get&nbsp;the&nbsp;response</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-get_accesskeyid"><strong>get_accesskeyid</strong></a>(self)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-get_body"><strong>get_body</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-get_headers"><strong>get_headers</strong></a>(self, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPMonitor-get_signature"><strong>get_signature</strong></a>(self, acc<font color="#909090">=None</font>)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPMonitor-receive"><strong>receive</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPMonitor-send"><strong>send</strong></a>(self, method, uri, body, headers)</dt></dl>

<dl><dt><a name="FGCPMonitor-set_conn"><strong>set_conn</strong></a>(self, conn)</dt></dl>

<dl><dt><a name="FGCPMonitor-set_key"><strong>set_key</strong></a>(self, key_string)</dt></dl>

<dl><dt><a name="FGCPMonitor-set_region"><strong>set_region</strong></a>(self, region)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><strong>api_version</strong> = '2012-02-18'</dl>

<dl><dt><strong>debug</strong> = 0</dl>

<dl><dt><strong>key_file</strong> = 'client.pem'</dl>

<dl><dt><strong>locale</strong> = 'en'</dl>

<dl><dt><strong>region</strong> = 'de'</dl>

<dl><dt><strong>timezone</strong> = 'Central European Time'</dl>

<dl><dt><strong>uri</strong> = '/ovissapi/endpoint'</dl>

<dl><dt><strong>user_agent</strong> = 'OViSS-API-CLIENT'</dl>

<dl><dt><strong>verbose</strong> = 0</dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPOperator">class <strong>FGCPOperator</strong></a>(<a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>FGCP&nbsp;Operator&nbsp;Methods<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.client.html#FGCPOperator">FGCPOperator</a></dd>
<dd><a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a></dd>
<dd><a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a></dd>
<dd><a href="fgcp.connection.html#FGCPProxyServer">fgcp.connection.FGCPProxyServer</a></dd>
<dd><a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPOperator-AttachPublicIPAndWait"><strong>AttachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Attach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;attached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.attach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-BackupVDiskAndWait"><strong>BackupVDiskAndWait</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Take&nbsp;Backup&nbsp;of&nbsp;VDisk&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;finished&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.backup(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-BackupVServerAndRestart"><strong>BackupVServerAndRestart</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Backup&nbsp;all&nbsp;VDisks&nbsp;of&nbsp;a&nbsp;VServer&nbsp;and&nbsp;restart&nbsp;the&nbsp;VServer&nbsp;(this&nbsp;might&nbsp;take&nbsp;a&nbsp;while)<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.backup(wait=True)<br>
for&nbsp;vdisk&nbsp;in&nbsp;vserver.list_vdisks():<br>
&nbsp;&nbsp;&nbsp;&nbsp;result&nbsp;=&nbsp;vdisk.backup(wait=True)<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-CleanupBackups"><strong>CleanupBackups</strong></a>(self, vsysId, vdiskId<font color="#909090">=None</font>)</dt><dd><tt>Clean&nbsp;up&nbsp;old&nbsp;VDisk&nbsp;backups&nbsp;e.g.&nbsp;to&nbsp;minimize&nbsp;disk&nbsp;space<br>
&nbsp;<br>
result&nbsp;=&nbsp;vdisk.cleanup_backups(max_num=100,&nbsp;max_age=None)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-DetachPublicIPAndWait"><strong>DetachPublicIPAndWait</strong></a>(self, vsysId, publicIp)</dt><dd><tt>Detach&nbsp;PublicIP&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;detached<br>
&nbsp;<br>
result&nbsp;=&nbsp;publicip.detach(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StartEFMAndWait"><strong>StartEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Start&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StartSystem"><strong>StartSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Start&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;started&nbsp;(TODO:&nbsp;define&nbsp;start&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.boot(wait=True)<br>
vsystem.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StartVServerAndWait"><strong>StartVServerAndWait</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Start&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;running<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.start(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StopEFMAndWait"><strong>StopEFMAndWait</strong></a>(self, vsysId, efmId)</dt><dd><tt>Stop&nbsp;EFM&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;loadbalancer.stop(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StopSystem"><strong>StopSystem</strong></a>(self, vsysName, verbose<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VSystem&nbsp;and&nbsp;wait&nbsp;until&nbsp;all&nbsp;VServers&nbsp;and&nbsp;EFMs&nbsp;are&nbsp;stopped&nbsp;(TODO:&nbsp;define&nbsp;stop&nbsp;sequence&nbsp;for&nbsp;vservers)<br>
&nbsp;<br>
vsystem.stop(wait=True)<br>
vsystem.shutdown(wait=True)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StopVServerAndWait"><strong>StopVServerAndWait</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt><dd><tt>Stop&nbsp;VServer&nbsp;and&nbsp;wait&nbsp;until&nbsp;it's&nbsp;stopped<br>
&nbsp;<br>
result&nbsp;=&nbsp;vserver.stop(wait=True,&nbsp;force=None)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-check_status"><strong>check_status</strong></a>(self, done_status, pass_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;to&nbsp;see&nbsp;if&nbsp;we&nbsp;get&nbsp;done_status,&nbsp;or&nbsp;something&nbsp;other&nbsp;than&nbsp;pass_status<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<dl><dt><a name="FGCPOperator-wait_for_status"><strong>wait_for_status</strong></a>(self, done_status, wait_status, status_method, *args)</dt><dd><tt>Call&nbsp;status_method(*args)&nbsp;repeatedly&nbsp;until&nbsp;we&nbsp;get&nbsp;done_status&nbsp;(or&nbsp;something&nbsp;else&nbsp;than&nbsp;wait_status)<br>
&nbsp;<br>
Obsolete&nbsp;-&nbsp;included&nbsp;in&nbsp;resource&nbsp;actions</tt></dd></dl>

<hr>
Methods inherited from <a href="fgcp.client.html#FGCPMonitor">FGCPMonitor</a>:<br>
<dl><dt><a name="FGCPOperator-FindSystemByName"><strong>FindSystemByName</strong></a>(self, vsysName)</dt><dd><tt>Find&nbsp;VSystem&nbsp;by&nbsp;vsysName<br>
&nbsp;<br>
vsystem&nbsp;=&nbsp;vdc.get_vsystem(vsysName)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetSystemInventory"><strong>GetSystemInventory</strong></a>(self, vsysName<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;VSystem&nbsp;inventory&nbsp;(by&nbsp;vsysName)<br>
&nbsp;<br>
vsystems&nbsp;=&nbsp;vdc.list_vsystems()<br>
inventory&nbsp;=&nbsp;vsystem.get_inventory()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetSystemStatus"><strong>GetSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, verbose<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
status&nbsp;=&nbsp;vsystem.get_status()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ShowSystemStatus"><strong>ShowSystemStatus</strong></a>(self, vsysName<font color="#909090">=None</font>, sep<font color="#909090">='<font color="#c040c0">\t</font>'</font>)</dt><dd><tt>Show&nbsp;the&nbsp;overall&nbsp;system&nbsp;status&nbsp;(for&nbsp;a&nbsp;particular&nbsp;VSystem)<br>
&nbsp;<br>
vdc.show_vsystem_status()<br>
vsystem.<a href="#FGCPOperator-show_status">show_status</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-getvdc"><strong>getvdc</strong></a>(self)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.command.html#FGCPCommand">fgcp.command.FGCPCommand</a>:<br>
<dl><dt><a name="FGCPOperator-AddAddressRange"><strong>AddAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPOperator-AllocatePublicIP"><strong>AllocatePublicIP</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPOperator-AttachPublicIP"><strong>AttachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPOperator-AttachVDisk"><strong>AttachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPOperator-BackupEFM"><strong>BackupEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPOperator-BackupVDisk"><strong>BackupVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPOperator-CreateAddressPool"><strong>CreateAddressPool</strong></a>(self, pipFrom<font color="#909090">=None</font>, pipTo<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-CreateEFM"><strong>CreateEFM</strong></a>(self, vsysId, efmType, efmName, networkId)</dt><dd><tt>Usage:&nbsp;efmId&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-CreateEFM">CreateEFM</a>(self,&nbsp;vsys.vsysId,&nbsp;'SLB',&nbsp;'My&nbsp;LoadBalancer',&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPOperator-CreateVDisk"><strong>CreateVDisk</strong></a>(self, vsysId, vdiskName, size)</dt><dd><tt>Usage:&nbsp;vdiskId&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-CreateVDisk">CreateVDisk</a>(self,&nbsp;vsys.vsysId,&nbsp;vdiskName,&nbsp;size)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-CreateVSYS"><strong>CreateVSYS</strong></a>(self, vsysDescriptorId, vsysName)</dt><dd><tt>Usage:&nbsp;vsysId&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-CreateVSYS">CreateVSYS</a>(vsysdescriptor.vsysdescriptorId,&nbsp;'My&nbsp;New&nbsp;System')</tt></dd></dl>

<dl><dt><a name="FGCPOperator-CreateVServer"><strong>CreateVServer</strong></a>(self, vsysId, vserverName, vserverType, diskImageId, networkId)</dt><dd><tt>Usage:&nbsp;vserverId&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-CreateVServer">CreateVServer</a>(self,&nbsp;vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Server',&nbsp;servertype.name,&nbsp;diskimage.diskimageId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPOperator-DeleteAddressRange"><strong>DeleteAddressRange</strong></a>(self, pipFrom, pipTo)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyEFM"><strong>DestroyEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyEFMBackup"><strong>DestroyEFMBackup</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyVDisk"><strong>DestroyVDisk</strong></a>(self, vsysId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyVDiskBackup"><strong>DestroyVDiskBackup</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyVSYS"><strong>DestroyVSYS</strong></a>(self, vsysId)</dt></dl>

<dl><dt><a name="FGCPOperator-DestroyVServer"><strong>DestroyVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPOperator-DetachPublicIP"><strong>DetachPublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPOperator-DetachVDisk"><strong>DetachVDisk</strong></a>(self, vsysId, vserverId, vdiskId)</dt></dl>

<dl><dt><a name="FGCPOperator-FreePublicIP"><strong>FreePublicIP</strong></a>(self, vsysId, publicIp)</dt></dl>

<dl><dt><a name="FGCPOperator-GetAddressRange"><strong>GetAddressRange</strong></a>(self)</dt><dd><tt>Usage:&nbsp;addressranges&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetAddressRange">GetAddressRange</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetDiskImageAttributes"><strong>GetDiskImageAttributes</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;diskimage&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetDiskImageAttributes">GetDiskImageAttributes</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetEFMAttributes"><strong>GetEFMAttributes</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;efmattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetEFMAttributes">GetEFMAttributes</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetEFMConfigHandler"><strong>GetEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;GetEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPGetEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;fw_policies&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetEFMConfigHandler">GetEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_policy(from_zone,&nbsp;to_zone)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetEFMConfiguration"><strong>GetEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;GetEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetEFMStatus"><strong>GetEFMStatus</strong></a>(self, vsysId, efmId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetEFMStatus">GetEFMStatus</a>(vsys.vsysId,&nbsp;loadbalancer.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetEventLog"><strong>GetEventLog</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;logs&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetEventLog">GetEventLog</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetInformation"><strong>GetInformation</strong></a>(self, all<font color="#909090">=None</font>, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;infos&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetInformation">GetInformation</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetPerformanceInformation"><strong>GetPerformanceInformation</strong></a>(self, vsysId, vserverId, interval<font color="#909090">='10minute'</font>, dataType<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;perfinfos&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetPerformanceInformation">GetPerformanceInformation</a>(vsys.vsysId,&nbsp;vserver.vserverId,&nbsp;interval='hour')</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetPublicIPAttributes"><strong>GetPublicIPAttributes</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;publicipattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetPublicIPAttributes">GetPublicIPAttributes</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetPublicIPStatus"><strong>GetPublicIPStatus</strong></a>(self, publicIp)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetPublicIPStatus">GetPublicIPStatus</a>(publicip.address)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetSystemUsage"><strong>GetSystemUsage</strong></a>(self, vsysIds<font color="#909090">=None</font>)</dt><dd><tt>NOTE:&nbsp;extra&nbsp;'date'&nbsp;element&nbsp;on&nbsp;top-level&nbsp;compared&nbsp;to&nbsp;other&nbsp;API&nbsp;calls&nbsp;!<br>
Usage:&nbsp;date,&nbsp;usage&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetSystemUsage">GetSystemUsage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVDiskAttributes"><strong>GetVDiskAttributes</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;vdiskattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVDiskAttributes">GetVDiskAttributes</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVDiskStatus"><strong>GetVDiskStatus</strong></a>(self, vsysId, vdiskId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVDiskStatus">GetVDiskStatus</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVSYSAttributes"><strong>GetVSYSAttributes</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVSYSAttributes">GetVSYSAttributes</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVSYSConfiguration"><strong>GetVSYSConfiguration</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vsysconfig&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVSYSConfiguration">GetVSYSConfiguration</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVSYSDescriptorAttributes"><strong>GetVSYSDescriptorAttributes</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVSYSDescriptorAttributes">GetVSYSDescriptorAttributes</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVSYSDescriptorConfiguration"><strong>GetVSYSDescriptorConfiguration</strong></a>(self, vsysDescriptorId)</dt><dd><tt>Usage:&nbsp;vsysdescriptorconfig&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVSYSDescriptorConfiguration">GetVSYSDescriptorConfiguration</a>(vsysdescriptor.vsysdescriptorId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVSYSStatus"><strong>GetVSYSStatus</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVSYSStatus">GetVSYSStatus</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVServerAttributes"><strong>GetVServerAttributes</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverattr&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVServerAttributes">GetVServerAttributes</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVServerConfiguration"><strong>GetVServerConfiguration</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;vserverconfig&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVServerConfiguration">GetVServerConfiguration</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVServerInitialPassword"><strong>GetVServerInitialPassword</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;initialpwd&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVServerInitialPassword">GetVServerInitialPassword</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-GetVServerStatus"><strong>GetVServerStatus</strong></a>(self, vsysId, vserverId)</dt><dd><tt>Usage:&nbsp;status&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetVServerStatus">GetVServerStatus</a>(vsys.vsysId,&nbsp;vserver.vserverId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListDiskImage"><strong>ListDiskImage</strong></a>(self, serverCategory<font color="#909090">=None</font>, vsysDescriptorId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;diskimages&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListDiskImage">ListDiskImage</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListEFM"><strong>ListEFM</strong></a>(self, vsysId, efmType)</dt><dd><tt>Usage:<br>
firewalls&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"FW")<br>
loadbalancers&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListEFM">ListEFM</a>(vsys.vsysId,&nbsp;"SLB")</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListEFMBackup"><strong>ListEFMBackup</strong></a>(self, vsysId, efmId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListEFMBackup">ListEFMBackup</a>(vsys.vsysId,&nbsp;firewall.efmId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListPublicIP"><strong>ListPublicIP</strong></a>(self, vsysId<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;publicips&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListPublicIP">ListPublicIP</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListServerType"><strong>ListServerType</strong></a>(self, diskImageId)</dt><dd><tt>Usage:&nbsp;servertypes&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListServerType">ListServerType</a>(diskimage.diskimageId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListVDisk"><strong>ListVDisk</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vdisks&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListVDisk">ListVDisk</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListVDiskBackup"><strong>ListVDiskBackup</strong></a>(self, vsysId, vdiskId, timeZone<font color="#909090">=None</font>, countryCode<font color="#909090">=None</font>)</dt><dd><tt>Usage:&nbsp;backups&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListVDiskBackup">ListVDiskBackup</a>(vsys.vsysId,&nbsp;vdisk.vdiskId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListVSYS"><strong>ListVSYS</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsystems&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListVSYS">ListVSYS</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListVSYSDescriptor"><strong>ListVSYSDescriptor</strong></a>(self)</dt><dd><tt>Usage:&nbsp;vsysdescriptors&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListVSYSDescriptor">ListVSYSDescriptor</a>()</tt></dd></dl>

<dl><dt><a name="FGCPOperator-ListVServer"><strong>ListVServer</strong></a>(self, vsysId)</dt><dd><tt>Usage:&nbsp;vservers&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-ListVServer">ListVServer</a>(vsys.vsysId)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-RegisterPrivateDiskImage"><strong>RegisterPrivateDiskImage</strong></a>(self, vserverId, name, description)</dt></dl>

<dl><dt><a name="FGCPOperator-RegisterPrivateVSYSDescriptor"><strong>RegisterPrivateVSYSDescriptor</strong></a>(self, vsysId, name, description, keyword, vservers)</dt><dd><tt>Usage:<br>
vsys&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-GetSystemInventory">GetSystemInventory</a>('My&nbsp;Existing&nbsp;VSYS')<br>
proxy.<a href="#FGCPOperator-RegisterPrivateVSYSDescriptor">RegisterPrivateVSYSDescriptor</a>(vsys.vsysId,&nbsp;'My&nbsp;New&nbsp;Template',&nbsp;'This&nbsp;is&nbsp;a&nbsp;new&nbsp;template&nbsp;based&nbsp;on&nbsp;my&nbsp;existing&nbsp;VSYS',&nbsp;'some&nbsp;key&nbsp;words',&nbsp;vsys.vservers)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-RestoreEFM"><strong>RestoreEFM</strong></a>(self, vsysId, efmId, backupId)</dt></dl>

<dl><dt><a name="FGCPOperator-RestoreVDisk"><strong>RestoreVDisk</strong></a>(self, vsysId, backupId)</dt></dl>

<dl><dt><a name="FGCPOperator-StandByConsole"><strong>StandByConsole</strong></a>(self, vsysId, networkId)</dt><dd><tt>Usage:&nbsp;url&nbsp;=&nbsp;proxy.<a href="#FGCPOperator-StandByConsole">StandByConsole</a>(vsys.vsysId,&nbsp;vsys.vnets[0])</tt></dd></dl>

<dl><dt><a name="FGCPOperator-StartEFM"><strong>StartEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPOperator-StartVServer"><strong>StartVServer</strong></a>(self, vsysId, vserverId)</dt></dl>

<dl><dt><a name="FGCPOperator-StopEFM"><strong>StopEFM</strong></a>(self, vsysId, efmId)</dt></dl>

<dl><dt><a name="FGCPOperator-StopVServer"><strong>StopVServer</strong></a>(self, vsysId, vserverId, force<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-UnregisterDiskImage"><strong>UnregisterDiskImage</strong></a>(self, diskImageId)</dt></dl>

<dl><dt><a name="FGCPOperator-UnregisterPrivateVSYSDescriptor"><strong>UnregisterPrivateVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPOperator-UnregisterVSYSDescriptor"><strong>UnregisterVSYSDescriptor</strong></a>(self, vsysDescriptorId)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateDiskImageAttribute"><strong>UpdateDiskImageAttribute</strong></a>(self, diskImageId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateEFMAttribute"><strong>UpdateEFMAttribute</strong></a>(self, vsysId, efmId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateEFMConfigHandler"><strong>UpdateEFMConfigHandler</strong></a>(self, vsysId, efmId)</dt><dd><tt>Handler&nbsp;for&nbsp;specific&nbsp;UpdateEFMConfiguration&nbsp;methods,&nbsp;see&nbsp;FGCPUpdateEFMConfigHandler&nbsp;for&nbsp;details<br>
Usage:&nbsp;proxy.<a href="#FGCPOperator-UpdateEFMConfigHandler">UpdateEFMConfigHandler</a>(vsys.vsysId,&nbsp;firewall.efmId).fw_dns('AUTO')</tt></dd></dl>

<dl><dt><a name="FGCPOperator-UpdateEFMConfiguration"><strong>UpdateEFMConfiguration</strong></a>(self, vsysId, efmId, configurationName, configurationXML<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Generic&nbsp;method&nbsp;for&nbsp;all&nbsp;UpdateEFMConfiguration&nbsp;methods</tt></dd></dl>

<dl><dt><a name="FGCPOperator-UpdateVDiskAttribute"><strong>UpdateVDiskAttribute</strong></a>(self, vsysId, vdiskId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateVSYSAttribute"><strong>UpdateVSYSAttribute</strong></a>(self, vsysId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateVSYSConfiguration"><strong>UpdateVSYSConfiguration</strong></a>(self, vsysId, configurationName, configurationValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateVSYSDescriptorAttribute"><strong>UpdateVSYSDescriptorAttribute</strong></a>(self, vsysDescriptorId, updateLcId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-UpdateVServerAttribute"><strong>UpdateVServerAttribute</strong></a>(self, vsysId, vserverId, attributeName, attributeValue)</dt></dl>

<dl><dt><a name="FGCPOperator-set_verbose"><strong>set_verbose</strong></a>(self, verbose<font color="#909090">=None</font>)</dt><dd><tt>Show&nbsp;output&nbsp;(1),&nbsp;status&nbsp;checks&nbsp;(2)&nbsp;or&nbsp;nothing&nbsp;(0)</tt></dd></dl>

<dl><dt><a name="FGCPOperator-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-show_status"><strong>show_status</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><a name="FGCPOperator-__init__"><strong>__init__</strong></a>(self, key_file<font color="#909090">='client.pem'</font>, region<font color="#909090">='de'</font>, verbose<font color="#909090">=0</font>, debug<font color="#909090">=0</font>, conn<font color="#909090">=None</font>)</dt><dd><tt>Use&nbsp;the&nbsp;same&nbsp;PEM&nbsp;file&nbsp;for&nbsp;SSL&nbsp;client&nbsp;certificate&nbsp;and&nbsp;RSA&nbsp;key&nbsp;signature<br>
&nbsp;<br>
Note:&nbsp;to&nbsp;convert&nbsp;your&nbsp;.p12&nbsp;or&nbsp;.pfx&nbsp;file&nbsp;to&nbsp;unencrypted&nbsp;PEM&nbsp;format,&nbsp;you&nbsp;can&nbsp;use<br>
the&nbsp;following&nbsp;'openssl'&nbsp;command:<br>
&nbsp;<br>
openssl&nbsp;pkcs12&nbsp;-in&nbsp;UserCert.p12&nbsp;-out&nbsp;client.pem&nbsp;-nodes</tt></dd></dl>

<dl><dt><a name="FGCPOperator-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPOperator-add_param"><strong>add_param</strong></a>(self, key<font color="#909090">=None</font>, value<font color="#909090">=None</font>, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-close"><strong>close</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPOperator-connect"><strong>connect</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPOperator-do_action"><strong>do_action</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt><dd><tt>Send&nbsp;the&nbsp;XML-RPC&nbsp;request&nbsp;and&nbsp;get&nbsp;the&nbsp;response</tt></dd></dl>

<dl><dt><a name="FGCPOperator-get_accesskeyid"><strong>get_accesskeyid</strong></a>(self)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPOperator-get_body"><strong>get_body</strong></a>(self, action, params<font color="#909090">=None</font>, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-get_headers"><strong>get_headers</strong></a>(self, attachments<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPOperator-get_signature"><strong>get_signature</strong></a>(self, acc<font color="#909090">=None</font>)</dt><dd><tt>#&nbsp;see&nbsp;com.fujitsu.oviss.pub.OViSSSignature</tt></dd></dl>

<dl><dt><a name="FGCPOperator-receive"><strong>receive</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPOperator-send"><strong>send</strong></a>(self, method, uri, body, headers)</dt></dl>

<dl><dt><a name="FGCPOperator-set_conn"><strong>set_conn</strong></a>(self, conn)</dt></dl>

<dl><dt><a name="FGCPOperator-set_key"><strong>set_key</strong></a>(self, key_string)</dt></dl>

<dl><dt><a name="FGCPOperator-set_region"><strong>set_region</strong></a>(self, region)</dt></dl>

<hr>
Data and other attributes inherited from <a href="fgcp.connection.html#FGCPConnection">fgcp.connection.FGCPConnection</a>:<br>
<dl><dt><strong>api_version</strong> = '2012-02-18'</dl>

<dl><dt><strong>debug</strong> = 0</dl>

<dl><dt><strong>key_file</strong> = 'client.pem'</dl>

<dl><dt><strong>locale</strong> = 'en'</dl>

<dl><dt><strong>region</strong> = 'de'</dl>

<dl><dt><strong>timezone</strong> = 'Central European Time'</dl>

<dl><dt><strong>uri</strong> = '/ovissapi/endpoint'</dl>

<dl><dt><strong>user_agent</strong> = 'OViSS-API-CLIENT'</dl>

<dl><dt><strong>verbose</strong> = 0</dl>

</td></tr></table></td></tr></table>
</body></html>